home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XSetWMIconName.z / XSetWMIconName
Encoding:
Text File  |  2002-10-03  |  5.5 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeettttWWWWMMMMIIIIccccoooonnnnNNNNaaaammmmeeee((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttWWWWMMMMIIIIccccoooonnnnNNNNaaaammmmeeee((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName -
  10.           set or read a window's WM_ICON_NAME property
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           void XSetWMIconName(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 Window _w;
  16.                 XTextProperty *_t_e_x_t__p_r_o_p;
  17.  
  18.           Status XGetWMIconName(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p__r_e_t_u_r_n)
  19.                 Display *_d_i_s_p_l_a_y;
  20.                 Window _w;
  21.                 XTextProperty *_t_e_x_t__p_r_o_p__r_e_t_u_r_n;
  22.  
  23.           XSetIconName(_d_i_s_p_l_a_y, _w, _i_c_o_n__n_a_m_e)
  24.                 Display *_d_i_s_p_l_a_y;
  25.                 Window _w;
  26.                 char *_i_c_o_n__n_a_m_e;
  27.  
  28.           Status XGetIconName(_d_i_s_p_l_a_y, _w, _i_c_o_n__n_a_m_e__r_e_t_u_r_n)
  29.                 Display *_d_i_s_p_l_a_y;
  30.                 Window _w;
  31.                 char **_i_c_o_n__n_a_m_e__r_e_t_u_r_n;
  32.  
  33.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  34.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  35.  
  36.           _i_c_o_n__n_a_m_e Specifies the icon name, which should be a null-
  37.                     terminated string.
  38.  
  39.           _i_c_o_n__n_a_m_e__r_e_t_u_r_n
  40.                     Returns the window's icon name, which is a null-
  41.                     terminated string.
  42.  
  43.           _t_e_x_t__p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
  44.  
  45.           _t_e_x_t__p_r_o_p__r_e_t_u_r_n
  46.                     Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  47.  
  48.           _w         Specifies the window.
  49.  
  50.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  51.           The _X_S_e_t_W_M_I_c_o_n_N_a_m_e convenience function calls
  52.           _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y to set the WM_ICON_NAME property.
  53.  
  54.           The _X_G_e_t_W_M_I_c_o_n_N_a_m_e convenience function calls
  55.           _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y to obtain the WM_ICON_NAME property.  It
  56.           returns a nonzero status on success; otherwise, it returns a
  57.           zero status.
  58.  
  59.           The _X_S_e_t_I_c_o_n_N_a_m_e function sets the name to be displayed in a
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeettttWWWWMMMMIIIIccccoooonnnnNNNNaaaammmmeeee((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttWWWWMMMMIIIIccccoooonnnnNNNNaaaammmmeeee((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           window's icon.
  75.  
  76.           _X_S_e_t_I_c_o_n_N_a_m_e can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  77.  
  78.           The _X_G_e_t_I_c_o_n_N_a_m_e function returns the name to be displayed
  79.           in the specified window's icon.  If it succeeds, it returns
  80.           a nonzero status; otherwise, if no icon name has been set
  81.           for the window, it returns zero.  If you never assigned a
  82.           name to the window, _X_G_e_t_I_c_o_n_N_a_m_e sets icon_name_return to
  83.           NULL.  If the data returned by the server is in the Latin
  84.           Portable Character Encoding, then the returned string is in
  85.           the Host Portable Character Encoding.  Otherwise, the result
  86.           is implementation-dependent.  When finished with it, a
  87.           client must free the icon name string using _X_F_r_e_e.
  88.  
  89.           _X_G_e_t_I_c_o_n_N_a_m_e can generate a _B_a_d_W_i_n_d_o_w error.
  90.  
  91.      PPPPRRRROOOOPPPPEEEERRRRTTTTIIIIEEEESSSS
  92.           WM_ICON_NAME
  93.                     The name to be used in an icon.
  94.  
  95.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  96.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  97.                     resource or server memory.
  98.  
  99.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  100.                     defined Window.
  101.  
  102.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  103.           XAllocClassHint(3X11), XAllocIconSize(3X11),
  104.           XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11),
  105.           XSetCommand(3X11), XSetTransientForHint(3X11),
  106.           XSetTextProperty(3X11), XSetWMClientMachine(3X11),
  107.           XSetWMColormapWindows(3X11), XSetWMName(3X11),
  108.           XSetWMProperties(3X11), XSetWMProtocols(3X11),
  109.           XStringListToTextProperty(3X11)
  110.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.